Build documentation strictly and fix docstrings - #45
Merged
Conversation
The documentation build now runs with --strict, so a broken link or a missing nav entry fails the build instead of warning and passing. Eight register docstrings now read "an int8" rather than "a int8", on the four signed scalar registers and the four signed array registers.
bruno-f-cruz
approved these changes
Aug 25, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Two small documentation fixes ahead of the release.
The documentation build in CI now runs with
--strict, so a broken link or a missing nav entry fails the build rather than warning and passing.mkdocs build --strictalready passes onmain, so this changes what CI enforces rather than what the site contains.Eight register docstrings now read "an int8" rather than "a int8", on the four signed scalar registers and the four signed array registers. Both groups render on the API reference page.